Obtener uso de la plataforma

Este endpoint devuelve un resumen del uso de la plataforma asociado a tu cuenta de Sheriff. Devuelve métricas agregadas (por ejemplo, consultas y monitoreos contratados vs. usados), información de vigencia del plan, límites aplicados y una predicción mensual con historial. Es útil para supervisar consumo, detectar excedentes y planificar renovaciones.

Detalle de API

Request

• URL: /usage
• Método: GET

Ejemplo request con curl

curl -X 'GET' \
  'https://prod.api.thesheriff.cl/api/clients/v2/usage' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9EjemploDeToken123' \
  -H 'x-client-identifier: SheriffSecureClient-v1'

Response

Success

• Status code: 200

• Example response body:

  {
    "success": true,
    "data": {
      "consultasContratadas": 10,
      "consultasRealizadas": 1,
      "monitoreosContratados": 10,
      "monitoreosUsados": 42,
      "informacionPlan": {
        "fechaInicioVigencia": "2025-10",
        "fechaFinVigencia": null
      },
      "limites": {
        "limiteConsultas": 10,
        "limiteMonitoreos": 10,
        "limiteLeafRut": 10
      },
      "monitoreos": {
        "monitoreosUsados": 42,
        "monitoreosContratados": 10,
        "monitoreosExcedidos": 32
      },
      "prediccionMensual": {
        "mesSiguiente": "2025-12",
        "consultasEstimadas": 3,
        "monitoreosEstimados": 3,
        "tendenciaConsultas": "decreciente",
        "tendenciaMonitores": "decreciente",
        "promedioUltimos3Meses": {
          "consultas": 3,
          "monitoreos": 3
        },
        "historialMensual": [
          {
            "mes": "2025-09",
            "consultas": 1,
            "monitoreos": 1
          },
          {
            "mes": "2025-10",
            "consultas": 8,
            "monitoreos": 7
          },
          {
            "mes": "2025-11",
            "consultas": 1,
            "monitoreos": 1
          }
        ]
      }
    }
  }

  A continuación se describen los campos devueltos en la respuesta JSON.

  Campo	Tipo	Descripción
  success	boolean	Indica si la operación fue exitosa.
  data	object	Objeto con el resumen de uso del cliente.

  Estructura del objeto data (campos principales):

  Campo	Tipo	Descripción
  consultasContratadas	number	Cantidad de consultas contratadas en el plan.
  consultasRealizadas	number	Consultas ya utilizadas.
  monitoreosContratados	number	Cantidad de monitoreos contratados en el plan.
  monitoreosUsados	number	Monitoreos ya utilizados.
  informacionPlan	object	Información de vigencia del plan.
  limites	object	Límites configurados por tipo (consultas, monitoreos, leaflet).
  monitoreos	object	Resumen específico de monitoreos (usados, contratados, excedidos).
  prediccionMensual	object	Predicción y historial de uso por mes.

  Detalle de objetos anidados y tipos:

  • informacionPlan:

  Campo	Tipo	Descripción
  fechaInicioVigencia	string	Mes de inicio de vigencia (formato YYYY-MM, puede ser parcial).
  fechaFinVigencia	string	Mes de fin de vigencia o null si no aplica.

  • limites:

  Campo	Tipo	Descripción
  limiteConsultas	number	Límite máximo de consultas para el cliente.
  limiteMonitoreos	number	Límite máximo de monitoreos para el cliente.
  limiteLeafRut	number	Límite para el uso de leaflet (u otro recurso nombrado así).

  • monitoreos (resumen):

  Campo	Tipo	Descripción
  monitoreosUsados	number	Monitoreos efectivamente usados.
  monitoreosContratados	number	Monitoreos contratados en el plan.
  monitoreosExcedidos	number	Cantidad de monitoreos que exceden el contrato (si aplica).

  • prediccionMensual:

  Campo	Tipo	Descripción
  mesSiguiente	string	Mes para la predicción (formato YYYY-MM).
  consultasEstimadas	number	Estimación de consultas para el mes siguiente.
  monitoreosEstimados	number	Estimación de monitoreos para el mes siguiente.
  tendenciaConsultas	string	Tendencia estimada (creciente/decreciente/estable).
  tendenciaMonitores	string	Tendencia estimada para monitoreos.
  promedioUltimos3Meses	object	Promedio de uso en los últimos 3 meses (campos consultas, monitoreos).
  historialMensual	array	Array con objetos por mes (mes, consultas, monitoreos).

  Nota: Los campos marcados como "No" pueden no estar presentes o ser null según disponibilidad de datos en la fuente.

  Errores

  400 - Solicitud inválida

  {
    "success": false,
    "code": 400,
    "error": "Solicitud inválida"
  }

  401 - No autorizado

  {
    "success": false,
    "code": 401,
    "error": "No autorizado"
  }

  403 - No tienes permiso para acceder a este recurso

  {
    "success": false,
    "code": 403,
    "error": "No tienes permiso para acceder a este recurso"
  }

  404 - Recurso no encontrado

  {
    "success": false,
    "code": 404,
    "error": "Recurso no encontrado"
  }

  408 - Tiempo de espera agotado

  {
    "success": false,
    "code": 408,
    "error": "Tiempo de espera agotado"
  }

  429 - Demasiadas solicitudes

  {
    "success": false,
    "code": 429,
    "error": "Demasiadas solicitudes"
  }

  500 - Error interno del servidor

  {
    "success": false,
    "code": 500,
    "error": "Error interno del servidor"
  }